.TH std::experimental::filesystem::path 3 "2024.06.10" "http://cppreference.com" "C++ Standard Libary"
.SH NAME
std::experimental::filesystem::path \- std::experimental::filesystem::path

.SH Synopsis
   Defined in header <experimental/filesystem>
   class path;                                  (filesystem TS)

   Objects of type path represent paths on a filesystem. Only syntactic aspects of
   paths are handled: the pathname may represent a non-existing path or even one that
   is not allowed to exist on the current file system or OS.

   The path name has the following syntax:

    1. root-name(optional): identifies the root on a filesystem with multiple roots
       (such as "C:" or "//myserver". POSIX filesystems have single root.
    2. root-directory(optional): a directory separator that, if present, marks this
       path as absolute. If it is missing (and the first element other than the root
       name is a file name), then the path is relative and requires another path as the
       starting location to resolve to a file name.
    3. Zero or more of the following:

     * file-name: sequence of characters that aren't directory separators or preferred
       directory separators (additional limitations may be imposed by the OS or file
       system). This name may identify a file, a hard link, a symbolic link, or a
       directory. Two special file-names are recognized:

     * dot: the file name consisting of a single dot character . is a directory name
       that refers to the current directory.
     * dot-dot: the file name consisting of two dot characters .. is a directory name
       that refers to the parent directory.
     * directory-separators: the forward slash character / or the alternative character
       provided as path::preferred_separator. If this character is repeated, it is
       treated as a single directory separator: /usr///////lib is the same as /usr/lib.

   The path can be traversed element-wise via iterators returned by the begin() and
   end() functions, which iterates over root name, root directory, and the subsequent
   file name elements (directory separators are skipped except the one that identifies
   the root directory). If the very last element in the path is a directory separator,
   the last iterator will dereference to a file name dot.

   Calling any non-const member function of a path invalidates all iterators referring
   to elements of that object.

   If the OS uses a native syntax that is different from the portable generic syntax
   described above, all library functions accept path names in both formats.

   Paths are implicitly convertible to and from std::basic_strings, which makes it
   possible to use them with other file APIs, e.g. as an argument to
   std::ifstream::open.

.SH Member types

   Type           Definition
   value_type     character type used by the native encoding of the filesystem: char on
                  POSIX, wchar_t on Windows
   string_type    std::basic_string<value_type>
   const_iterator a constant LegacyBidirectionalIterator with a value_type of path
   iterator       an alias to const_iterator

.SH Member constants

                        alternative directory separator which may be used in addition
   constexpr value_type to the portable /. On Windows, this is the backslash character
   preferred_separator  \\. On POSIX, this is the same forward slash / as the portable
   \fB[static]\fP             separator
                        \fI(public static member constant)\fP

.SH Member functions

   constructor          constructs a path
                        \fI(public member function)\fP
   destructor           destroys a path object
                        \fI(public member function)\fP
   operator=            assigns another path
                        \fI(public member function)\fP
   assign               assigns contents
                        \fI(public member function)\fP
         Concatenation
   append               appends elements to the path
   operator/=           \fI(public member function)\fP
   concat               concatenates two paths without introducing a directory
   operator+=           separator
                        \fI(public member function)\fP
.SH Modifiers
   clear                erases the contents
                        \fI(public member function)\fP
   make_preferred       converts directory separators to preferred directory separator
                        \fI(public member function)\fP
   remove_filename      removes filename path component
                        \fI(public member function)\fP
   replace_filename     replaces the last path component with another path
                        \fI(public member function)\fP
   replace_extension    replaces the extension
                        \fI(public member function)\fP
   swap                 swaps two paths
                        \fI(public member function)\fP
         Format observers
   c_str                returns the native version of the path
   native               \fI(public member function)\fP
   operator string_type
   string
   wstring              returns the path in native pathname format converted to a
   u8string             string
   u16string            \fI(public member function)\fP
   u32string
   generic_string
   generic_wstring      returns the path in generic pathname format converted to a
   generic_u8string     string
   generic_u16string    \fI(public member function)\fP
   generic_u32string
         Compare
                        compares the lexical representations of two paths
   compare              lexicographically
                        \fI(public member function)\fP
         Decomposition
   root_name            returns the root-name of the path, if present
                        \fI(public member function)\fP
   root_directory       returns the root directory of the path, if present
                        \fI(public member function)\fP
   root_path            returns the root path of the path, if present
                        \fI(public member function)\fP
   relative_path        returns path relative to the root path
                        \fI(public member function)\fP
   parent_path          returns the path of the parent path
                        \fI(public member function)\fP
   filename             returns the filename path component
                        \fI(public member function)\fP
   stem                 returns the stem path component
                        \fI(public member function)\fP
   extension            returns the file extension path component
                        \fI(public member function)\fP
         Queries
   empty                checks if the path is empty
                        \fI(public member function)\fP
   has_root_path
   has_root_name
   has_root_directory
   has_relative_path    checks if the corresponding path element is not empty
   has_parent_path      \fI(public member function)\fP
   has_filename
   has_stem
   has_extension
   is_absolute          checks if root_path() uniquely identifies file system location
   is_relative          \fI(public member function)\fP
.SH Iterators
   begin                iterator access to the path as a sequence of elements
   end                  \fI(public member function)\fP

.SH Non-member functions

   swap(std::experimental::filesystem::path) swaps two paths
                                             \fI(function)\fP
   operator==
   operator!=
   operator<                                 lexicographically compares two paths
   operator<=                                \fI(function)\fP
   operator>
   operator>=
                                             concatenates two paths with a directory
   operator/                                 separator
                                             \fI(function)\fP
   operator<<                                performs stream input and output on a path
   operator>>                                \fI(function)\fP
   u8path                                    creates a path from a UTF-8 encoded source
                                             \fI(function)\fP

.SH Category:
     * Noindexed pages
